/***************************************************************************
 * Copyright 2012-2013 TXT e-solutions SpA
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * 
 * This work was performed within the IoT_at_Work Project
 * and partially funded by the European Commission's
 * 7th Framework Programme under the contract ICT-257367.
 *
 * Authors:
 *      Salvatore Piccione (TXT e-solutions SpA)
 *
 * Contributors:
 *        Domenico Rotondi (TXT e-solutions SpA)
 **************************************************************************/
package it.txt.ens.core;

import java.net.URI;

/**
 * This class represents a resource of the Event Notification Service.<br/>A resource is
 * basically an event stream managed by the ENS and related to a branch, a subset or a 
 * single node of a specific namespace. This resource is identified by an URI in the following
 * format:<pre>amqp://&lt;host>/&lt;path>?Namespace:&lt;namespace>&amp;Pattern:&lt;pattern></pre>
 * 
 * @author Salvatore Piccione (TXT e-solutions SpA - salvatore.piccione AT txtgroup.com)
 * @author Domenico Rotondi (TXT e-solutions SpA - domenico.rotondi AT txtgroup.com)
 *
 */
public interface ENSResource {
    /**
     * The name of the URI query parameter indicating the namespace.
     */
    public static final String NAMESPACE_PARAMETER_NAME = "Namespace";
    /**
     * The name of the URI query parameter indicating the namespace pattern
     * (i.e. the identifier of a branch, a subset or a single node of a namespace).
     */
    public static final String PATTERN_PARAMETER_NAME = "Pattern";
    static final String SLASH = "/";
    /**
     * The default path.
     */
    public static final String DEFAULT_PATH = SLASH + "ENS";
    /**
     * The URI scheme.
     */
    public static final String URI_SCHEME = "amqp";
    
    /**
     * Returns the host name/IP address of this resource's URI.
     * 
     * @return the host name/IP address of the resource's URI.
     */
    public String getHost ();
    
    /**
     * Returns the path of this resource's URI.
     * 
     * @return the path of this resource's URI.
     */
    public String getPath ();
    
    /**
     * Returns the namespace of this resource's URI.
     * @return the namespace of this resource's URI.
     */
    public String getNamespace ();
    
    /**
     * Returns the pattern of this resource's URI.
     * 
     * @return the pattern of this resource's URI.
     */
    public String getPattern ();
    
    /**
     * Returns the resource's URI.
     * 
     * @return the resource's URI.
     */
    public URI getURI ();
}
